手持式人证合一验证设备平台接口协议v0.0.1
本协议主要是为了第三方系统与广东东信智能科技有限公司手持式身份证验证平台通过Http Post方式进行数据交互，文档是面向具备一定的http开发经验的开发者。
《智能手持式人证合一验证设备平台接口协议v0.0.1》
目 录
1.简介1
1.1.Https方式接入1
1.2.面向的读者1
1.3.返回数据1
2.协议定义1
2.1.上传人证比对记录1
2.1.1.描述1
2.1.2.接口定义1
2.1.3.输入参数1
2.1.4.输出参数2
2.2.发送设备心跳2
2.2.1.描述2
2.2.2.接口定义2
2.2.3.输入参数2
2.2.4.输出参数2
2.3.设备注册3
2.3.1.描述3
2.3.2.接口定义3
2.3.3.输入参数3
2.3.4.输出参数3
2.4.获取验证策略3
2.4.1.描述3
2.4.2.接口定义3
2.4.3.输入参数3
2.4.4.输出参数4
2.5.获取版本4
2.5.1.描述4
2.5.2.接口定义4
2.5.3.输入参数4
2.5.4.输出参数4
1.简介
1.1.Https方式接入
第三方系统与人证合一平台通过Http Post方式进行数据交互。
本协议涉及到的中文均采用UTF-8编码格式，为了显示美观数据样本手工加入折行。
1.2.面向的读者
《人证合一平台接口协议》文档是面向具备一定的http开发经验的开发者。
1.3.返回数据
该平台提供的接口返回数据为json。
2.协议定义
2.1.上传人证比对记录
2.1.1.描述
人证合一客户端将比对记录上传到平台，平台保存比对记录用于后续操作。
2.1.2.接口定义
https://ip:port/fvms/api/uploadCmpRecord
2.1.3.输入参数
参数名称类型必填参数说明备注
deviceNoString(1,64) Y设备号
nameString(1,32)Y姓名
cardnoString(1,18)Y证件号
cardImgStringY身份证照base64数据
spotImgStringY现场照base64数据
scoresmallint (3)Y对比分数
thresholdsmallint (3)Y阈值
validateType
smallint (1)Y验证模式(1：只验人脸 2：人脸或指纹任意通过 3：人脸、指纹同时通过)
faceResultsmallint (1)Y人脸比对结果（1：成功 2：失败 3：未检测到人脸）
fingerResultsmallint (1)Y指纹比对结果（1：成功 2：失败 3：未检测到指纹 4.指纹不检只验证人脸 4
fingerNumString(3)Y指纹现场比对次数(-,0/1 1/1)只验证人脸 -
resultsmallint (1)Y最终结果（1：成功 2：失败 3：未检测到人脸 4：未检测到指纹 ）
folkString(30)Y民族
sexsmallint (1)Y性别（1：男 2：女 3：未知）
birthdayString(10)Y生日
addressString(1,255)Y家庭地址
validdate1String(1,16)Y身份证开始有效期
validdate2String(1,16)Y身份证结束有效期
authorityString(1,128)Y签发机关
compareDatelongY比对时间
请求样例：
requestData="{"address":"重庆市渝中区龙华大道","authority":"重庆市渝中区公安局","birthday":"1999-03-02","cardImg":"/9j/4AAQSkZJRgAB…"
,"spotImg":"/9j/4AAQSkZJRgAB…","threshold":80,"validateType":1,"validdate1":"2001-05-10","validdate2":"2020-05-10"}"
2.1.4.输出参数
返回值名称类型必填参数说明备注
codeint Y返回码，0成功，非0失败
msgString(1,128) N返回码描述
返回样例：
{"code":0,"msg":"成功"}
2.2.发送设备心跳
2.2.1.描述
人证合一客户端向平台定时发送设备心跳，通知服务器设备当前的状态。
2.2.2.接口定义
https://ip:port/fvms/api/checkHeartRate
2.2.3.输入参数
参数名称类型必填参数说明备注
deviceNoString(1,64) Y设备号
请求样例：
requestData="{"deviceNo":"111111"}"
2.2.4.输出参数
返回值名称类型必填参数说明备注
codeint Y返回码，0成功，非0失败
msgString(1,128) N返回码描述
返回样例：
{"code":0,"msg":"成功"}
2.3.设备注册
2.3.1.描述
人证合一客户端向平台发送设备信息，平台将设备添加到数据库中，用于后续维护管理。
2.3.2.接口定义
https://ip:port/fvms/api/regDevice
2.3.3.输入参数
参数名称类型必填参数说明备注
deviceNoString(1,64) Y设备号
deviceTypesmallint (1)Y设备类型（1：PC 2：安卓）
modelString(1,20)Y型号
systemString(1,32)Y系统
firmString(1,32)Y厂商
versionNoString(1,20)Y版本号
请求样例：
requestData="{"deviceNo":"22222","deviceType":2,"firm":"索尼","model":"XD-301","system":"魔神360","versionNo":"1.0.0.001"}"
2.3.4.输出参数
返回值名称类型必填参数说明备注
codeint Y返回码，0成功，非0失败
msgString(1,128) N返回码描述
返回样例：
{"code":0,"msg":"成功"}
2.4.获取验证策略
2.4.1.描述
人证合一客户端向平台获取验证策略，用于配置人证比对的参数。
2.4.2.接口定义
https://ip:port/fvms/api/getValidatePolicy
2.4.3.输入参数
参数名称类型必填参数说明备注
deviceNoString(1,64) Y设备号
请求样例：
requestData="{"deviceNo":"22222"}"
2.4.4.输出参数
返回值名称类型必填参数说明备注
codeint Y返回码，0成功，非0失败
msgString(1,128) N返回码描述
validateTypesmallint(1)N验证模式(1：只验人脸 2：人脸或指纹任意通过 3：人脸、指纹同时通过)
thresholdsmallint(3)N阈值
fingerStatussmallint(1)N指纹验证状态（1：开启 2：关闭）
fingerNumsmallint(1)N指纹验证次数
backWelcomeTimesmallint(2)N从“视频界面”退到“欢迎界面”的时间
faceCheckTimesmallint(2)N人脸检测时间
fingerCheckTimesmallint(2)N指纹检测时间
disappearTimesmallint(2)N右侧身份证信息消失的时间
返回样例：
{"backWelcomeTime":99,"code":0,"disappearTime":42,"faceCheckTime":44,"fingerCheckTime":55,"fingerNum":0,"fingerStatus":2,"msg":"成功","threshold":75,"validateType":1}
2.5.获取版本
2.5.1.描述
人证合一客户端向平台获取最新的app版本更新包，用于客户端升级app应用。
2.5.2.接口定义
https://ip:port/fvms/api/getVersion
2.5.3.输入参数
参数名称类型必填参数说明备注
versionNoString(1,20) Y版本号(0.0.0.000)
versionTypesmallint(1)Y版本类型（1：PC 2：安卓）
请求样例：
requestData="{"versionNo":"2.0.0.000","versionType":2}"
2.5.4.输出参数
返回值名称类型必填参数说明备注
codeint Y返回码，0成功，非0失败
msgString(1,128) N响应消息
downloadAddrString(1,128)N下载地址，只有当获取到最新的版本时，才会返回对应的下载地址
versionNoString(1,20)N版本号
返回样例：
{"code":0,"downloadAddr":"http://192.168.10.218:82/file/1484125938759_node_exporter-0.13.0.linux-amd64.tar.gz","msg":"成功","versionNo":"2.1.1.444"}
产品咨询